/*-
 * RP.java          TP-Reply-Path (TP-RP)
 *
 * $LastChangedBy: stein $
 * $LastChangedRevision: 95 $
 * $LastChangedDate: 2007-02-13 16:19:24 +0000 (Tue, 13 Feb 2007) $
 * $HeadURL: svn://localhost/SMS/src/com/googlecode/attention/sms/pdu/RP.java $
 *
 * Copyright (c) 2007, Stein Gunnar Bakkeby
 * All rights reserved.
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *     * Neither the name of Stein Gunnar Bakkeby nor the names of its
 *       contributors may be used to endorse or promote products derived
 *       from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS "AS IS" AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package com.googlecode.attention.sms.pdu;

import static com.googlecode.attention.util.bit.ByteBitValues.*;

/**
 * TP-Reply-Path (TP-RP).
 * <BR>
 * The TP-Reply-Path is a 1-bit field, located within
 * bit no 7 of the first octet of both SMS-DELIVER and SMS-SUBMIT,
 * and to be given the following values:
 * <BR>
 * <BR>Bit no 7:
 * <BR><TABLE>
 * <TR><TD>0</TD><TD>TP-Reply-Path parameter is not set in this SMS-SUBMIT/DELIVER</TD></TR>
 * <TR><TD>1</TD><TD>TP-Reply-Path parameter is set in this SMS-SUBMIT/DELIVER</TD>
 * </TABLE>
 * <BR>Please refer to annex D in 3GPP TS 23.040 version 5.8.1 Release 5
 * for details about the Reply procedures.
 *  
 * @author Stein Gunnar Bakkeby
 */
public enum RP {

  /** TP-Reply-Path parameter is not set in this SMS-SUBMIT/DELIVER. */
  PARAM_NOT_SET(0),
  /** TP-Reply-Path parameter is set in this SMS-SUBMIT/DELIVER. */
  PARAM_SET(B7); // B7
  
  /** The binary value of this RP. */
  public final int value;
  
  private RP(final int value) {
    this.value = value;
  }
  
  /**
   * This will return the correct RP enum based on the integer passed in.
   * 
   * @param value Can be bit 7 of the first octet, or the first octet itself
   * @return The corresponding RP enum
   */
  public static RP parse(final int value) {
    switch (value & B7) {
    case B7:
      return PARAM_SET;
    case 0:
    default:
      return PARAM_NOT_SET;
    }
  }
}